<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Database xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/torque/engine/database/model/Database.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../../../org/apache/torque/engine/database/model/package-summary.html">org.apache.torque.engine.database.model</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Collections;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.HashMap;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Hashtable;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Iterator;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.List;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Map;
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.commons.collections.map.ListOrderedMap;
<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.torque.engine.EngineException;
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.torque.engine.database.transform.DTDResolver;
<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.torque.engine.platform.Platform;
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.torque.engine.platform.PlatformFactory;
<a name="37" href="#37">37</a>  <strong>import</strong> org.xml.sax.Attributes;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  
<a name="40" href="#40">40</a>  <em>/**<em>*</em></em>
<a name="41" href="#41">41</a>  <em> * A class for holding application data structures.</em>
<a name="42" href="#42">42</a>  <em> *</em>
<a name="43" href="#43">43</a>  <em> * @author &lt;a href="<a href="mailto:leon@opticode.co.za" target="alexandria_uri">mailto:leon@opticode.co.za</a>>Leon Messerschmidt&lt;/a></em>
<a name="44" href="#44">44</a>  <em> * @author &lt;a href="<a href="mailto:jmcnally@collab.net" target="alexandria_uri">mailto:jmcnally@collab.net</a>>John McNally&lt;/a></em>
<a name="45" href="#45">45</a>  <em> * @author &lt;a href="<a href="mailto:mpoeschl@marmot.at" target="alexandria_uri">mailto:mpoeschl@marmot.at</a>>Martin Poeschl&lt;/a></em>
<a name="46" href="#46">46</a>  <em> * @author &lt;a href="<a href="mailto:dlr@collab.net" target="alexandria_uri">mailto:dlr@collab.net</a>>Daniel Rall&lt;/a></em>
<a name="47" href="#47">47</a>  <em> * @author &lt;a href="<a href="mailto:byron_foster@byron_foster@yahoo.com" target="alexandria_uri">mailto:byron_foster@byron_foster@yahoo.com</a>>Byron Foster&lt;/a></em>
<a name="48" href="#48">48</a>  <em> * @author &lt;a href="<a href="mailto:monroe@dukece.com" target="alexandria_uri">mailto:monroe@dukece.com</a>>Greg Monroe&lt;/a></em>
<a name="49" href="#49">49</a>  <em> * @version $Id: Database.java 473814 2006-11-11 22:30:30Z tv $</em>
<a name="50" href="#50">50</a>  <em> */</em>
<a name="51" href="#51">51</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Database.html">Database</a>
<a name="52" href="#52">52</a>  {
<a name="53" href="#53">53</a>      <em>/**<em>* Logging class from commons.logging */</em></em>
<a name="54" href="#54">54</a>      <strong>private</strong> <strong>static</strong> Log log = LogFactory.getLog(Database.<strong>class</strong>);
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>      <strong>private</strong> String databaseType = <strong>null</strong>;
<a name="57" href="#57">57</a>      <strong>private</strong> List tableList = <strong>new</strong> ArrayList(100);
<a name="58" href="#58">58</a>      <strong>private</strong> Map domainMap = <strong>new</strong> HashMap();
<a name="59" href="#59">59</a>      <strong>private</strong> String name;
<a name="60" href="#60">60</a>      <strong>private</strong> String javaName;
<a name="61" href="#61">61</a>      <strong>private</strong> String pkg;
<a name="62" href="#62">62</a>      <strong>private</strong> String baseClass;
<a name="63" href="#63">63</a>      <strong>private</strong> String basePeer;
<a name="64" href="#64">64</a>      <strong>private</strong> String defaultIdMethod;
<a name="65" href="#65">65</a>      <strong>private</strong> String defaultJavaType;
<a name="66" href="#66">66</a>      <strong>private</strong> String defaultJavaNamingMethod;
<a name="67" href="#67">67</a>      <strong>private</strong> Hashtable tablesByName = <strong>new</strong> Hashtable();
<a name="68" href="#68">68</a>      <strong>private</strong> Hashtable tablesByJavaName = <strong>new</strong> Hashtable();
<a name="69" href="#69">69</a>      <strong>private</strong> <strong>boolean</strong> heavyIndexing;
<a name="70" href="#70">70</a>      <em>/**<em>* the name of the definition file */</em></em>
<a name="71" href="#71">71</a>      <strong>private</strong> String fileName;
<a name="72" href="#72">72</a>      <strong>private</strong> Map options = Collections.synchronizedMap(<strong>new</strong> ListOrderedMap());
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em>/**<em>*</em></em>
<a name="76" href="#76">76</a>  <em>     * Creates a new instance for the specified database type.</em>
<a name="77" href="#77">77</a>  <em>     *</em>
<a name="78" href="#78">78</a>  <em>     * @param databaseType The default type for this database.</em>
<a name="79" href="#79">79</a>  <em>     */</em>
<a name="80" href="#80">80</a>      <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Database.html">Database</a>(String databaseType)
<a name="81" href="#81">81</a>      {
<a name="82" href="#82">82</a>          <strong>this</strong>.databaseType = databaseType;
<a name="83" href="#83">83</a>      }
<a name="84" href="#84">84</a>  
<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
<a name="86" href="#86">86</a>  <em>     * Load the database object from an xml tag.</em>
<a name="87" href="#87">87</a>  <em>     *</em>
<a name="88" href="#88">88</a>  <em>     * @param attrib the xml attributes</em>
<a name="89" href="#89">89</a>  <em>     */</em>
<a name="90" href="#90">90</a>      <strong>public</strong> <strong>void</strong> loadFromXML(Attributes attrib)
<a name="91" href="#91">91</a>      {
<a name="92" href="#92">92</a>          setName(attrib.getValue(<span class="string">"name"</span>));
<a name="93" href="#93">93</a>          pkg = attrib.getValue(<span class="string">"package"</span>);
<a name="94" href="#94">94</a>          baseClass = attrib.getValue(<span class="string">"baseClass"</span>);
<a name="95" href="#95">95</a>          basePeer = attrib.getValue(<span class="string">"basePeer"</span>);
<a name="96" href="#96">96</a>          defaultJavaType = attrib.getValue(<span class="string">"defaultJavaType"</span>);
<a name="97" href="#97">97</a>          defaultIdMethod = attrib.getValue(<span class="string">"defaultIdMethod"</span>);
<a name="98" href="#98">98</a>          defaultJavaNamingMethod = attrib.getValue(<span class="string">"defaultJavaNamingMethod"</span>);
<a name="99" href="#99">99</a>          <strong>if</strong> (defaultJavaNamingMethod == <strong>null</strong>)
<a name="100" href="#100">100</a>         {
<a name="101" href="#101">101</a>             defaultJavaNamingMethod = NameGenerator.CONV_METHOD_UNDERSCORE;
<a name="102" href="#102">102</a>         }
<a name="103" href="#103">103</a>         heavyIndexing = <span class="string">"true"</span>.equals(attrib.getValue(<span class="string">"heavyIndexing"</span>));
<a name="104" href="#104">104</a>     }
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
<a name="107" href="#107">107</a> <em>     * Get the name of the Database</em>
<a name="108" href="#108">108</a> <em>     *</em>
<a name="109" href="#109">109</a> <em>     * @return name of the Database</em>
<a name="110" href="#110">110</a> <em>     */</em>
<a name="111" href="#111">111</a>     <strong>public</strong> String getName()
<a name="112" href="#112">112</a>     {
<a name="113" href="#113">113</a>         <strong>return</strong> name;
<a name="114" href="#114">114</a>     }
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a>     <em>/**<em>*</em></em>
<a name="117" href="#117">117</a> <em>     * Set the name of the Database</em>
<a name="118" href="#118">118</a> <em>     *</em>
<a name="119" href="#119">119</a> <em>     * @param name name of the Database</em>
<a name="120" href="#120">120</a> <em>     */</em>
<a name="121" href="#121">121</a>     <strong>public</strong> <strong>void</strong> setName(String name)
<a name="122" href="#122">122</a>     {
<a name="123" href="#123">123</a>         <em>/**<em>* @task check this */</em></em>
<a name="124" href="#124">124</a> <em class="comment">//        this.name = (name == null ? Torque.getDefaultDB() : name);</em>
<a name="125" href="#125">125</a>         <strong>this</strong>.name = (name == <strong>null</strong> ? <span class="string">"default"</span> : name);
<a name="126" href="#126">126</a>     }
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>     <strong>public</strong> String getFileName()
<a name="129" href="#129">129</a>     {
<a name="130" href="#130">130</a>         <strong>return</strong> fileName;
<a name="131" href="#131">131</a>     }
<a name="132" href="#132">132</a> 
<a name="133" href="#133">133</a>     <strong>public</strong> <strong>void</strong> setFileName(String name)
<a name="134" href="#134">134</a>     {
<a name="135" href="#135">135</a>         <strong>this</strong>.fileName = name;
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     <em>/**<em>*</em></em>
<a name="139" href="#139">139</a> <em>     * Get the value of package.</em>
<a name="140" href="#140">140</a> <em>     * @return value of package.</em>
<a name="141" href="#141">141</a> <em>     */</em>
<a name="142" href="#142">142</a>     <strong>public</strong> String getPackage()
<a name="143" href="#143">143</a>     {
<a name="144" href="#144">144</a>         <strong>return</strong> pkg;
<a name="145" href="#145">145</a>     }
<a name="146" href="#146">146</a> 
<a name="147" href="#147">147</a>     <em>/**<em>*</em></em>
<a name="148" href="#148">148</a> <em>     * Set the value of package.</em>
<a name="149" href="#149">149</a> <em>     * @param v  Value to assign to package.</em>
<a name="150" href="#150">150</a> <em>     */</em>
<a name="151" href="#151">151</a>     <strong>public</strong> <strong>void</strong> setPackage(String v)
<a name="152" href="#152">152</a>     {
<a name="153" href="#153">153</a>         <strong>this</strong>.pkg = v;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em>/**<em>*</em></em>
<a name="157" href="#157">157</a> <em>     * Get the value of baseClass.</em>
<a name="158" href="#158">158</a> <em>     * @return value of baseClass.</em>
<a name="159" href="#159">159</a> <em>     */</em>
<a name="160" href="#160">160</a>     <strong>public</strong> String getBaseClass()
<a name="161" href="#161">161</a>     {
<a name="162" href="#162">162</a>         <strong>if</strong> (baseClass == <strong>null</strong>)
<a name="163" href="#163">163</a>         {
<a name="164" href="#164">164</a>             <strong>return</strong> <span class="string">"BaseObject"</span>;
<a name="165" href="#165">165</a>         }
<a name="166" href="#166">166</a>         <strong>return</strong> baseClass;
<a name="167" href="#167">167</a>     }
<a name="168" href="#168">168</a> 
<a name="169" href="#169">169</a>     <em>/**<em>*</em></em>
<a name="170" href="#170">170</a> <em>     * Set the value of baseClass.</em>
<a name="171" href="#171">171</a> <em>     * @param v  Value to assign to baseClass.</em>
<a name="172" href="#172">172</a> <em>     */</em>
<a name="173" href="#173">173</a>     <strong>public</strong> <strong>void</strong> setBaseClass(String v)
<a name="174" href="#174">174</a>     {
<a name="175" href="#175">175</a>         <strong>this</strong>.baseClass = v;
<a name="176" href="#176">176</a>     }
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>     <em>/**<em>*</em></em>
<a name="179" href="#179">179</a> <em>     * Get the value of basePeer.</em>
<a name="180" href="#180">180</a> <em>     * @return value of basePeer.</em>
<a name="181" href="#181">181</a> <em>     */</em>
<a name="182" href="#182">182</a>     <strong>public</strong> String getBasePeer()
<a name="183" href="#183">183</a>     {
<a name="184" href="#184">184</a>         <strong>if</strong> (basePeer == <strong>null</strong>)
<a name="185" href="#185">185</a>         {
<a name="186" href="#186">186</a>             <strong>return</strong> <span class="string">"BasePeer"</span>;
<a name="187" href="#187">187</a>         }
<a name="188" href="#188">188</a>         <strong>return</strong> basePeer;
<a name="189" href="#189">189</a>     }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>     <em>/**<em>*</em></em>
<a name="192" href="#192">192</a> <em>     * Set the value of basePeer.</em>
<a name="193" href="#193">193</a> <em>     * @param v Value to assign to basePeer.</em>
<a name="194" href="#194">194</a> <em>     */</em>
<a name="195" href="#195">195</a>     <strong>public</strong> <strong>void</strong> setBasePeer(String v)
<a name="196" href="#196">196</a>     {
<a name="197" href="#197">197</a>         <strong>this</strong>.basePeer = v;
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em>/**<em>*</em></em>
<a name="201" href="#201">201</a> <em>     * Get the value of defaultIdMethod.</em>
<a name="202" href="#202">202</a> <em>     * @return value of defaultIdMethod.</em>
<a name="203" href="#203">203</a> <em>     */</em>
<a name="204" href="#204">204</a>     <strong>public</strong> String getDefaultIdMethod()
<a name="205" href="#205">205</a>     {
<a name="206" href="#206">206</a>         <strong>return</strong> defaultIdMethod;
<a name="207" href="#207">207</a>     }
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>     <em>/**<em>*</em></em>
<a name="210" href="#210">210</a> <em>     * Set the value of defaultIdMethod.</em>
<a name="211" href="#211">211</a> <em>     * @param v Value to assign to defaultIdMethod.</em>
<a name="212" href="#212">212</a> <em>     */</em>
<a name="213" href="#213">213</a>     <strong>public</strong> <strong>void</strong> setDefaultIdMethod(String v)
<a name="214" href="#214">214</a>     {
<a name="215" href="#215">215</a>         <strong>this</strong>.defaultIdMethod = v;
<a name="216" href="#216">216</a>     }
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>     <em>/**<em>*</em></em>
<a name="219" href="#219">219</a> <em>     * Get type to use in Java sources (primitive || object)</em>
<a name="220" href="#220">220</a> <em>     *</em>
<a name="221" href="#221">221</a> <em>     * @return the type to use</em>
<a name="222" href="#222">222</a> <em>     */</em>
<a name="223" href="#223">223</a>     <strong>public</strong> String getDefaultJavaType()
<a name="224" href="#224">224</a>     {
<a name="225" href="#225">225</a>         <strong>return</strong> defaultJavaType;
<a name="226" href="#226">226</a>     }
<a name="227" href="#227">227</a> 
<a name="228" href="#228">228</a>     <em>/**<em>*</em></em>
<a name="229" href="#229">229</a> <em>     * Get the value of defaultJavaNamingMethod which specifies the</em>
<a name="230" href="#230">230</a> <em>     * method for converting schema names for table and column to Java names.</em>
<a name="231" href="#231">231</a> <em>     *</em>
<a name="232" href="#232">232</a> <em>     * @return The default naming conversion used by this database.</em>
<a name="233" href="#233">233</a> <em>     */</em>
<a name="234" href="#234">234</a>     <strong>public</strong> String getDefaultJavaNamingMethod()
<a name="235" href="#235">235</a>     {
<a name="236" href="#236">236</a>         <strong>return</strong> defaultJavaNamingMethod;
<a name="237" href="#237">237</a>     }
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a>     <em>/**<em>*</em></em>
<a name="240" href="#240">240</a> <em>     * Set the value of defaultJavaNamingMethod.</em>
<a name="241" href="#241">241</a> <em>     * @param v The default naming conversion for this database to use.</em>
<a name="242" href="#242">242</a> <em>     */</em>
<a name="243" href="#243">243</a>     <strong>public</strong> <strong>void</strong> setDefaultJavaNamingMethod(String v)
<a name="244" href="#244">244</a>     {
<a name="245" href="#245">245</a>         <strong>this</strong>.defaultJavaNamingMethod = v;
<a name="246" href="#246">246</a>     }
<a name="247" href="#247">247</a> 
<a name="248" href="#248">248</a>     <em>/**<em>*</em></em>
<a name="249" href="#249">249</a> <em>     * Get the value of heavyIndexing.</em>
<a name="250" href="#250">250</a> <em>     * @return value of heavyIndexing.</em>
<a name="251" href="#251">251</a> <em>     */</em>
<a name="252" href="#252">252</a>     <strong>public</strong> <strong>boolean</strong> isHeavyIndexing()
<a name="253" href="#253">253</a>     {
<a name="254" href="#254">254</a>         <strong>return</strong> heavyIndexing;
<a name="255" href="#255">255</a>     }
<a name="256" href="#256">256</a> 
<a name="257" href="#257">257</a>     <em>/**<em>*</em></em>
<a name="258" href="#258">258</a> <em>     * Set the value of heavyIndexing.</em>
<a name="259" href="#259">259</a> <em>     * @param v  Value to assign to heavyIndexing.</em>
<a name="260" href="#260">260</a> <em>     */</em>
<a name="261" href="#261">261</a>     <strong>public</strong> <strong>void</strong> setHeavyIndexing(<strong>boolean</strong> v)
<a name="262" href="#262">262</a>     {
<a name="263" href="#263">263</a>         <strong>this</strong>.heavyIndexing = v;
<a name="264" href="#264">264</a>     }
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>     <em>/**<em>*</em></em>
<a name="267" href="#267">267</a> <em>     * Return an List of all tables</em>
<a name="268" href="#268">268</a> <em>     *</em>
<a name="269" href="#269">269</a> <em>     * @return List of all tables</em>
<a name="270" href="#270">270</a> <em>     */</em>
<a name="271" href="#271">271</a>     <strong>public</strong> List getTables()
<a name="272" href="#272">272</a>     {
<a name="273" href="#273">273</a>         <strong>return</strong> tableList;
<a name="274" href="#274">274</a>     }
<a name="275" href="#275">275</a> 
<a name="276" href="#276">276</a>     <em>/**<em>*</em></em>
<a name="277" href="#277">277</a> <em>     * Return the table with the specified name.</em>
<a name="278" href="#278">278</a> <em>     *</em>
<a name="279" href="#279">279</a> <em>     * @param name table name</em>
<a name="280" href="#280">280</a> <em>     * @return A Table object.  If it does not exist it returns null</em>
<a name="281" href="#281">281</a> <em>     */</em>
<a name="282" href="#282">282</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> getTable(String name)
<a name="283" href="#283">283</a>     {
<a name="284" href="#284">284</a>         <strong>return</strong> (Table) tablesByName.get(name);
<a name="285" href="#285">285</a>     }
<a name="286" href="#286">286</a> 
<a name="287" href="#287">287</a>     <em>/**<em>*</em></em>
<a name="288" href="#288">288</a> <em>     * Return the table with the specified javaName.</em>
<a name="289" href="#289">289</a> <em>     *</em>
<a name="290" href="#290">290</a> <em>     * @param javaName name of the java object representing the table</em>
<a name="291" href="#291">291</a> <em>     * @return A Table object.  If it does not exist it returns null</em>
<a name="292" href="#292">292</a> <em>     */</em>
<a name="293" href="#293">293</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> getTableByJavaName(String javaName)
<a name="294" href="#294">294</a>     {
<a name="295" href="#295">295</a>         <strong>return</strong> (Table) tablesByJavaName.get(javaName);
<a name="296" href="#296">296</a>     }
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>     <em>/**<em>*</em></em>
<a name="299" href="#299">299</a> <em>     * An utility method to add a new table from an xml attribute.</em>
<a name="300" href="#300">300</a> <em>     *</em>
<a name="301" href="#301">301</a> <em>     * @param attrib the xml attributes</em>
<a name="302" href="#302">302</a> <em>     * @return the created Table</em>
<a name="303" href="#303">303</a> <em>     */</em>
<a name="304" href="#304">304</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> addTable(Attributes attrib)
<a name="305" href="#305">305</a>     {
<a name="306" href="#306">306</a>         <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> tbl = <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a>();
<a name="307" href="#307">307</a>         tbl.setDatabase(<strong>this</strong>);
<a name="308" href="#308">308</a>         tbl.loadFromXML(attrib, <strong>this</strong>.getDefaultIdMethod());
<a name="309" href="#309">309</a>         addTable(tbl);
<a name="310" href="#310">310</a>         <strong>return</strong> tbl;
<a name="311" href="#311">311</a>     }
<a name="312" href="#312">312</a> 
<a name="313" href="#313">313</a>     <em>/**<em>*</em></em>
<a name="314" href="#314">314</a> <em>     * Add a table to the list and sets the Database property to this Database</em>
<a name="315" href="#315">315</a> <em>     *</em>
<a name="316" href="#316">316</a> <em>     * @param tbl the table to add</em>
<a name="317" href="#317">317</a> <em>     */</em>
<a name="318" href="#318">318</a>     <strong>public</strong> <strong>void</strong> addTable(<a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> tbl)
<a name="319" href="#319">319</a>     {
<a name="320" href="#320">320</a>         tbl.setDatabase(<strong>this</strong>);
<a name="321" href="#321">321</a>         tableList.add(tbl);
<a name="322" href="#322">322</a>         tablesByName.put(tbl.getName(), tbl);
<a name="323" href="#323">323</a>         tablesByJavaName.put(tbl.getJavaName(), tbl);
<a name="324" href="#324">324</a>         tbl.setPackage(getPackage());
<a name="325" href="#325">325</a>     }
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>     <strong>public</strong> <strong>void</strong> addDomain(<a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a> domain)
<a name="328" href="#328">328</a>     {
<a name="329" href="#329">329</a>         domainMap.put(domain.getName(), domain);
<a name="330" href="#330">330</a>     }
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/database/model/Domain.html">Domain</a> getDomain(String domainName)
<a name="333" href="#333">333</a>     {
<a name="334" href="#334">334</a>         <strong>return</strong> (Domain) domainMap.get(domainName);
<a name="335" href="#335">335</a>     }
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <strong>protected</strong> String getDatabaseType()
<a name="338" href="#338">338</a>     {
<a name="339" href="#339">339</a>         <strong>return</strong> databaseType;
<a name="340" href="#340">340</a>     }
<a name="341" href="#341">341</a> 
<a name="342" href="#342">342</a>     <strong>public</strong> <strong>void</strong> setDatabaseType(String databaseType)
<a name="343" href="#343">343</a>     {
<a name="344" href="#344">344</a>         <strong>this</strong>.databaseType = databaseType;
<a name="345" href="#345">345</a>     }
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>     <em>/**<em>*</em></em>
<a name="348" href="#348">348</a> <em>     * Returns the Platform implementation for this database.</em>
<a name="349" href="#349">349</a> <em>     *</em>
<a name="350" href="#350">350</a> <em>     * @return a Platform implementation</em>
<a name="351" href="#351">351</a> <em>     */</em>
<a name="352" href="#352">352</a>     <strong>public</strong> <a href="../../../../../../org/apache/torque/engine/platform/Platform.html">Platform</a> getPlatform()
<a name="353" href="#353">353</a>     {
<a name="354" href="#354">354</a>         <strong>return</strong> PlatformFactory.getPlatformFor(databaseType);
<a name="355" href="#355">355</a>     }
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>     <em>/**<em>*</em></em>
<a name="358" href="#358">358</a> <em>     * Determines if this database will be using the</em>
<a name="359" href="#359">359</a> <em>     * &lt;code>IDMethod.ID_BROKER&lt;/code> to create ids for torque OM</em>
<a name="360" href="#360">360</a> <em>     * objects.</em>
<a name="361" href="#361">361</a> <em>     * @return true if there is at least one table in this database that</em>
<a name="362" href="#362">362</a> <em>     * uses the &lt;code>IDMethod.ID_BROKER&lt;/code> method of generating</em>
<a name="363" href="#363">363</a> <em>     * ids. returns false otherwise.</em>
<a name="364" href="#364">364</a> <em>     */</em>
<a name="365" href="#365">365</a>     <strong>public</strong> <strong>boolean</strong> requiresIdTable()
<a name="366" href="#366">366</a>     {
<a name="367" href="#367">367</a>         Iterator iter = getTables().iterator();
<a name="368" href="#368">368</a>         <strong>while</strong> (iter.hasNext())
<a name="369" href="#369">369</a>         {
<a name="370" href="#370">370</a>             <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> table = (Table) iter.next();
<a name="371" href="#371">371</a>             <strong>if</strong> (table.getIdMethod().equals(IDMethod.ID_BROKER))
<a name="372" href="#372">372</a>             {
<a name="373" href="#373">373</a>                 <strong>return</strong> <strong>true</strong>;
<a name="374" href="#374">374</a>             }
<a name="375" href="#375">375</a>         }
<a name="376" href="#376">376</a>         <strong>return</strong> false;
<a name="377" href="#377">377</a>     }
<a name="378" href="#378">378</a> 
<a name="379" href="#379">379</a>     <em>/**<em>*</em></em>
<a name="380" href="#380">380</a> <em>     * Initializes the model.</em>
<a name="381" href="#381">381</a> <em>     *</em>
<a name="382" href="#382">382</a> <em>     * @throws EngineException</em>
<a name="383" href="#383">383</a> <em>     */</em>
<a name="384" href="#384">384</a>     <strong>public</strong> <strong>void</strong> doFinalInitialization() throws EngineException
<a name="385" href="#385">385</a>     {
<a name="386" href="#386">386</a>         Iterator iter = getTables().iterator();
<a name="387" href="#387">387</a>         <strong>while</strong> (iter.hasNext())
<a name="388" href="#388">388</a>         {
<a name="389" href="#389">389</a>             <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> currTable = (Table) iter.next();
<a name="390" href="#390">390</a> 
<a name="391" href="#391">391</a>             <em class="comment">// check schema integrity</em>
<a name="392" href="#392">392</a>             <em class="comment">// if idMethod="autoincrement", make sure a column is</em>
<a name="393" href="#393">393</a>             <em class="comment">// specified as autoIncrement="true"</em>
<a name="394" href="#394">394</a>             <em class="comment">// FIXME: Handle idMethod="native" via DB adapter.</em>
<a name="395" href="#395">395</a>             <em class="comment">// TODO autoincrement is no longer supported!!!</em>
<a name="396" href="#396">396</a>             <strong>if</strong> (currTable.getIdMethod().equals(<span class="string">"autoincrement"</span>))
<a name="397" href="#397">397</a>             {
<a name="398" href="#398">398</a>                 <strong>boolean</strong> foundOne = false;
<a name="399" href="#399">399</a>                 Iterator colIter = currTable.getColumns().iterator();
<a name="400" href="#400">400</a>                 <strong>while</strong> (colIter.hasNext() &amp;&amp; !foundOne)
<a name="401" href="#401">401</a>                 {
<a name="402" href="#402">402</a>                     foundOne = ((Column) colIter.next()).isAutoIncrement();
<a name="403" href="#403">403</a>                 }
<a name="404" href="#404">404</a> 
<a name="405" href="#405">405</a>                 <strong>if</strong> (!foundOne)
<a name="406" href="#406">406</a>                 {
<a name="407" href="#407">407</a>                     String errorMessage = <span class="string">"Table '"</span> + currTable.getName()
<a name="408" href="#408">408</a>                             + <span class="string">"' is marked as autoincrement, but it does not "</span>
<a name="409" href="#409">409</a>                             + <span class="string">"have a column which declared as the one to "</span>
<a name="410" href="#410">410</a>                             + <span class="string">"auto increment (i.e. autoIncrement=\&quot;true\&quot;)\n"</span>;
<a name="411" href="#411">411</a>                     <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/EngineException.html">EngineException</a>(<span class="string">"Error in XML schema: "</span> + errorMessage);
<a name="412" href="#412">412</a>                 }
<a name="413" href="#413">413</a>             }
<a name="414" href="#414">414</a> 
<a name="415" href="#415">415</a>             currTable.doFinalInitialization();
<a name="416" href="#416">416</a> 
<a name="417" href="#417">417</a>             <em class="comment">// setup reverse fk relations</em>
<a name="418" href="#418">418</a>             Iterator fks = currTable.getForeignKeys().iterator();
<a name="419" href="#419">419</a>             <strong>while</strong> (fks.hasNext())
<a name="420" href="#420">420</a>             {
<a name="421" href="#421">421</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/ForeignKey.html">ForeignKey</a> currFK = (ForeignKey) fks.next();
<a name="422" href="#422">422</a>                 <a href="../../../../../../org/apache/torque/engine/database/model/Table.html">Table</a> foreignTable = getTable(currFK.getForeignTableName());
<a name="423" href="#423">423</a>                 <strong>if</strong> (foreignTable == <strong>null</strong>)
<a name="424" href="#424">424</a>                 {
<a name="425" href="#425">425</a>                     <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/EngineException.html">EngineException</a>(<span class="string">"Attempt to set foreign"</span>
<a name="426" href="#426">426</a>                             + <span class="string">" key to nonexistent table, "</span>
<a name="427" href="#427">427</a>                             + currFK.getForeignTableName());
<a name="428" href="#428">428</a>                 }
<a name="429" href="#429">429</a>                 <strong>else</strong>
<a name="430" href="#430">430</a>                 {
<a name="431" href="#431">431</a>                     <em class="comment">// TODO check type and size</em>
<a name="432" href="#432">432</a>                     List referrers = foreignTable.getReferrers();
<a name="433" href="#433">433</a>                     <strong>if</strong> ((referrers == <strong>null</strong> || !referrers.contains(currFK)))
<a name="434" href="#434">434</a>                     {
<a name="435" href="#435">435</a>                         foreignTable.addReferrer(currFK);
<a name="436" href="#436">436</a>                     }
<a name="437" href="#437">437</a> 
<a name="438" href="#438">438</a>                     <em class="comment">// local column references</em>
<a name="439" href="#439">439</a>                     Iterator localColumnNames = currFK.getLocalColumns().iterator();
<a name="440" href="#440">440</a>                     <strong>while</strong> (localColumnNames.hasNext())
<a name="441" href="#441">441</a>                     {
<a name="442" href="#442">442</a>                         <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> local = currTable
<a name="443" href="#443">443</a>                                 .getColumn((String) localColumnNames.next());
<a name="444" href="#444">444</a>                         <em class="comment">// give notice of a schema inconsistency.</em>
<a name="445" href="#445">445</a>                         <em class="comment">// note we do not prevent the npe as there is nothing</em>
<a name="446" href="#446">446</a>                         <em class="comment">// that we can do, if it is to occur.</em>
<a name="447" href="#447">447</a>                         <strong>if</strong> (local == <strong>null</strong>)
<a name="448" href="#448">448</a>                         {
<a name="449" href="#449">449</a>                             <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/EngineException.html">EngineException</a>(<span class="string">"Attempt to define foreign"</span>
<a name="450" href="#450">450</a>                                     + <span class="string">" key with nonexistent column in table, "</span>
<a name="451" href="#451">451</a>                                     + currTable.getName());
<a name="452" href="#452">452</a>                         }
<a name="453" href="#453">453</a>                         <strong>else</strong>
<a name="454" href="#454">454</a>                         {
<a name="455" href="#455">455</a>                             <em class="comment">//check for foreign pk's</em>
<a name="456" href="#456">456</a>                             <strong>if</strong> (local.isPrimaryKey())
<a name="457" href="#457">457</a>                             {
<a name="458" href="#458">458</a>                                 currTable.setContainsForeignPK(<strong>true</strong>);
<a name="459" href="#459">459</a>                             }
<a name="460" href="#460">460</a>                         }
<a name="461" href="#461">461</a>                     }
<a name="462" href="#462">462</a> 
<a name="463" href="#463">463</a>                     <em class="comment">// foreign column references</em>
<a name="464" href="#464">464</a>                     Iterator foreignColumnNames
<a name="465" href="#465">465</a>                             = currFK.getForeignColumns().iterator();
<a name="466" href="#466">466</a>                     <strong>while</strong> (foreignColumnNames.hasNext())
<a name="467" href="#467">467</a>                     {
<a name="468" href="#468">468</a>                         String foreignColumnName = (String) foreignColumnNames.next();
<a name="469" href="#469">469</a>                         <a href="../../../../../../org/apache/torque/engine/database/model/Column.html">Column</a> foreign = foreignTable.getColumn(foreignColumnName);
<a name="470" href="#470">470</a>                         <em class="comment">// if the foreign column does not exist, we may have an</em>
<a name="471" href="#471">471</a>                         <em class="comment">// external reference or a misspelling</em>
<a name="472" href="#472">472</a>                         <strong>if</strong> (foreign == <strong>null</strong>)
<a name="473" href="#473">473</a>                         {
<a name="474" href="#474">474</a>                             <strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/torque/engine/EngineException.html">EngineException</a>(<span class="string">"Attempt to set foreign"</span>
<a name="475" href="#475">475</a>                                     + <span class="string">" key to nonexistent column: table="</span>
<a name="476" href="#476">476</a>                                     +  currTable.getName() + <span class="string">", foreign column="</span>
<a name="477" href="#477">477</a>                                     +  foreignColumnName);
<a name="478" href="#478">478</a>                         }
<a name="479" href="#479">479</a>                         <strong>else</strong>
<a name="480" href="#480">480</a>                         {
<a name="481" href="#481">481</a>                             foreign.addReferrer(currFK);
<a name="482" href="#482">482</a>                         }
<a name="483" href="#483">483</a>                     }
<a name="484" href="#484">484</a>                 }
<a name="485" href="#485">485</a>             }
<a name="486" href="#486">486</a>         }
<a name="487" href="#487">487</a>     }
<a name="488" href="#488">488</a> 
<a name="489" href="#489">489</a>     <em>/**<em>*</em></em>
<a name="490" href="#490">490</a> <em>     * Get the base name to use when creating related Java Classes.</em>
<a name="491" href="#491">491</a> <em>     *</em>
<a name="492" href="#492">492</a> <em>     * @return A Java syntax capatible version of the dbName using the method</em>
<a name="493" href="#493">493</a> <em>     *         defined by the defaultJavaNamingMethod XML value.</em>
<a name="494" href="#494">494</a> <em>     */</em>
<a name="495" href="#495">495</a>     <strong>public</strong> String getJavaName()
<a name="496" href="#496">496</a>     {
<a name="497" href="#497">497</a>         <strong>if</strong> (javaName == <strong>null</strong>)
<a name="498" href="#498">498</a>         {
<a name="499" href="#499">499</a>             List inputs = <strong>new</strong> ArrayList(2);
<a name="500" href="#500">500</a>             inputs.add(name);
<a name="501" href="#501">501</a>             inputs.add(defaultJavaNamingMethod);
<a name="502" href="#502">502</a>             <strong>try</strong>
<a name="503" href="#503">503</a>             {
<a name="504" href="#504">504</a>                 javaName = NameFactory.generateName(NameFactory.JAVA_GENERATOR,
<a name="505" href="#505">505</a>                                                     inputs);
<a name="506" href="#506">506</a>             }
<a name="507" href="#507">507</a>             <strong>catch</strong> (EngineException e)
<a name="508" href="#508">508</a>             {
<a name="509" href="#509">509</a>                 log.error(e, e);
<a name="510" href="#510">510</a>             }
<a name="511" href="#511">511</a>         }
<a name="512" href="#512">512</a>         <strong>return</strong> javaName;
<a name="513" href="#513">513</a>     }
<a name="514" href="#514">514</a> 
<a name="515" href="#515">515</a>     <em>/**<em>*</em></em>
<a name="516" href="#516">516</a> <em>     * Convert dbName to a Java compatible name by the JavaName method only</em>
<a name="517" href="#517">517</a> <em>     * (ignores the defaultJavaNamingMethod).</em>
<a name="518" href="#518">518</a> <em>     *</em>
<a name="519" href="#519">519</a> <em>     * @return The current dbName converted to a standard format that can</em>
<a name="520" href="#520">520</a> <em>     *          be used as part of a Java Object name.</em>
<a name="521" href="#521">521</a> <em>     */</em>
<a name="522" href="#522">522</a>     <strong>public</strong> String getStandardJavaName()
<a name="523" href="#523">523</a>     {
<a name="524" href="#524">524</a>         <strong>if</strong> (javaName == <strong>null</strong>)
<a name="525" href="#525">525</a>         {
<a name="526" href="#526">526</a>             List inputs = <strong>new</strong> ArrayList(2);
<a name="527" href="#527">527</a>             inputs.add(name);
<a name="528" href="#528">528</a>             inputs.add(NameGenerator.CONV_METHOD_JAVANAME);
<a name="529" href="#529">529</a>             <strong>try</strong>
<a name="530" href="#530">530</a>             {
<a name="531" href="#531">531</a>                 javaName = NameFactory.generateName(NameFactory.JAVA_GENERATOR,
<a name="532" href="#532">532</a>                                                     inputs);
<a name="533" href="#533">533</a>             }
<a name="534" href="#534">534</a>             <strong>catch</strong> (EngineException e)
<a name="535" href="#535">535</a>             {
<a name="536" href="#536">536</a>                 log.error(e, e);
<a name="537" href="#537">537</a>             }
<a name="538" href="#538">538</a>         }
<a name="539" href="#539">539</a>         <strong>return</strong> javaName;
<a name="540" href="#540">540</a>     }
<a name="541" href="#541">541</a> 
<a name="542" href="#542">542</a>     <em>/**<em>*</em></em>
<a name="543" href="#543">543</a> <em>     * Creats a string representation of this Database.</em>
<a name="544" href="#544">544</a> <em>     * The representation is given in xml format.</em>
<a name="545" href="#545">545</a> <em>     *</em>
<a name="546" href="#546">546</a> <em>     * @return string representation in xml</em>
<a name="547" href="#547">547</a> <em>     */</em>
<a name="548" href="#548">548</a>     <strong>public</strong> String toString()
<a name="549" href="#549">549</a>     {
<a name="550" href="#550">550</a>         StringBuffer result = <strong>new</strong> StringBuffer();
<a name="551" href="#551">551</a> 
<a name="552" href="#552">552</a>         result.append (<span class="string">"&lt;?xml version=\&quot;1.0\&quot;?>\n"</span>);
<a name="553" href="#553">553</a>         result.append (<span class="string">"&lt;!DOCTYPE database SYSTEM \&quot;"</span>
<a name="554" href="#554">554</a>                 + DTDResolver.WEB_SITE_DTD + <span class="string">"\&quot;>\n"</span>);
<a name="555" href="#555">555</a>         result.append(<span class="string">"&lt;!-- Autogenerated by SQLToXMLSchema! -->\n"</span>);
<a name="556" href="#556">556</a>         result.append(<span class="string">"&lt;database name=\&quot;"</span>).append(getName()).append('&quot;')
<a name="557" href="#557">557</a>             .append(<span class="string">" package=\&quot;"</span>).append(getPackage()).append('&quot;')
<a name="558" href="#558">558</a>             .append(<span class="string">" defaultIdMethod=\&quot;"</span>).append(getDefaultIdMethod())
<a name="559" href="#559">559</a>             .append('&quot;')
<a name="560" href="#560">560</a>             .append(<span class="string">" baseClass=\&quot;"</span>).append(getBaseClass()).append('&quot;')
<a name="561" href="#561">561</a>             .append(<span class="string">" basePeer=\&quot;"</span>).append(getBasePeer()).append('&quot;')
<a name="562" href="#562">562</a>             .append(<span class="string">">\n"</span>);
<a name="563" href="#563">563</a> 
<a name="564" href="#564">564</a>         <strong>for</strong> (Iterator i = tableList.iterator(); i.hasNext();)
<a name="565" href="#565">565</a>         {
<a name="566" href="#566">566</a>             result.append(i.next());
<a name="567" href="#567">567</a>         }
<a name="568" href="#568">568</a> 
<a name="569" href="#569">569</a>         result.append(<span class="string">"&lt;/database>"</span>);
<a name="570" href="#570">570</a>         <strong>return</strong> result.toString();
<a name="571" href="#571">571</a>     }
<a name="572" href="#572">572</a> 
<a name="573" href="#573">573</a>     <em>/**<em>*</em></em>
<a name="574" href="#574">574</a> <em>     * Add an XML Specified option key/value pair to this element's option set.</em>
<a name="575" href="#575">575</a> <em>     *</em>
<a name="576" href="#576">576</a> <em>     * @param key the key of the option.</em>
<a name="577" href="#577">577</a> <em>     * @param value the value of the option.</em>
<a name="578" href="#578">578</a> <em>     */</em>
<a name="579" href="#579">579</a>     <strong>public</strong> <strong>void</strong> addOption(String key, String value)
<a name="580" href="#580">580</a>     {
<a name="581" href="#581">581</a>         options.put(key, value);
<a name="582" href="#582">582</a>     }
<a name="583" href="#583">583</a> 
<a name="584" href="#584">584</a>     <em>/**<em>*</em></em>
<a name="585" href="#585">585</a> <em>     * Get the value that was associated with this key in an XML option</em>
<a name="586" href="#586">586</a> <em>     * element.</em>
<a name="587" href="#587">587</a> <em>     *</em>
<a name="588" href="#588">588</a> <em>     * @param key the key of the option.</em>
<a name="589" href="#589">589</a> <em>     * @return The value for the key or a null.</em>
<a name="590" href="#590">590</a> <em>     */</em>
<a name="591" href="#591">591</a>     <strong>public</strong> String getOption(String key)
<a name="592" href="#592">592</a>     {
<a name="593" href="#593">593</a>         <strong>return</strong> (String) options.get(key);
<a name="594" href="#594">594</a>     }
<a name="595" href="#595">595</a> 
<a name="596" href="#596">596</a>     <em>/**<em>*</em></em>
<a name="597" href="#597">597</a> <em>     * Gets the full ordered hashtable array of items specified by XML option</em>
<a name="598" href="#598">598</a> <em>     * statements under this element.&lt;p></em>
<a name="599" href="#599">599</a> <em>     *</em>
<a name="600" href="#600">600</a> <em>     * Note, this is not thread save but since it's only used for</em>
<a name="601" href="#601">601</a> <em>     * generation which is single threaded, there should be minimum</em>
<a name="602" href="#602">602</a> <em>     * danger using this in Velocity.</em>
<a name="603" href="#603">603</a> <em>     *</em>
<a name="604" href="#604">604</a> <em>     * @return An Map of all options. Will not be null but may be empty.</em>
<a name="605" href="#605">605</a> <em>     */</em>
<a name="606" href="#606">606</a>     <strong>public</strong> Map getOptions()
<a name="607" href="#607">607</a>     {
<a name="608" href="#608">608</a>         <strong>return</strong> options;
<a name="609" href="#609">609</a>     }
<a name="610" href="#610">610</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

